Package com.cisco.pt.ipc.sim
Interface DHCPPool
- All Superinterfaces:
IPCObject
- All Known Implementing Classes:
DHCPPoolImpl
Information provided by the PKI file:
\class DhcpPool
\brief DhcpPool holds and manipulates the DHCP pool on the DHCP server.
\example network().getDevice("Router0").getProcess("DhcpServer").getPoolAt(0)
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptionInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:getEndIp()Information provided by the PKI file:getLeaseAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:voidsetDefaultRouter(IPAddress ipAddress) Information provided by the PKI file:voidsetDnsServerIp(IPAddress ipAddress) Information provided by the PKI file:voidInformation provided by the PKI file:voidsetMaxUsers(int max) Information provided by the PKI file:voidsetNetworkAddress(IPAddress ipAddress) voidsetNetworkMask(IPAddress network, IPAddress mask) Information provided by the PKI file:voidsetNextAvailableIpAddress(IPAddress ipAddress) voidsetStartIp(IPAddress ipAddress) Information provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Method Details
-
getDhcpPoolName
String getDhcpPoolName()Information provided by the PKI file:
\brief Returns the name of this pool. \return string, the name of this pool.- Returns:
- String Returns a String
-
getNetworkAddress
IPAddress getNetworkAddress()Information provided by the PKI file:
\brief Returns the network address of this pool. \return ip, the network address of this pool.- Returns:
- IPAddress Returns a IPAddress
-
setNetworkMask
Information provided by the PKI file:
\brief Sets the network address for this pool. \param network, the network address for this pool. \param mask, the subnet mask for this pool.- Parameters:
network- Takes in a parameter of networkmask- Takes in a parameter of mask
-
getSubnetMask
IPAddress getSubnetMask()Information provided by the PKI file:
\brief Returns the subnet mask of this pool \return ip, the subnet mask of this pool.- Returns:
- IPAddress Returns a IPAddress
-
setDefaultRouter
Information provided by the PKI file:
\brief Sets the default router address. \param ipAddress, the IP address of the default router.- Parameters:
ipAddress- Takes in a parameter of ipAddress
-
getDefaultRouter
IPAddress getDefaultRouter()Information provided by the PKI file:
\brief Returns the default router IP address. \return ip, the default router IP address.- Returns:
- IPAddress Returns a IPAddress
-
getLeaseAt
Information provided by the PKI file:
\brief Returns the DHCP lease at the specified index. \param index, the index of the DHCP lease of interest. \return DhcpPoolLease, the DhcpPoolLease object at the specified index.- Parameters:
index- Takes in a parameter of index- Returns:
- DHCPPoolLease Returns a DHCPPoolLease
-
setStartIp
Information provided by the PKI file:
\brief Sets the start IP address for this pool. \param ipAddress, the start IP address for this pool.- Parameters:
ipAddress- Takes in a parameter of ipAddress
-
setNextAvailableIpAddress
- Parameters:
ipAddress- Takes in a parameter of ipAddress
-
setEndIp
Information provided by the PKI file:
\brief Sets the end IP address for this pool. \param ipAddress, the end IP address for this pool.- Parameters:
ipAddress- Takes in a parameter of ipAddress
-
setNetworkAddress
- Parameters:
ipAddress- Takes in a parameter of ipAddress
-
getStartIp
IPAddress getStartIp()Information provided by the PKI file:
\brief Returns the start IP address of this pool. \return ip, the start IP address of this pool.- Returns:
- IPAddress Returns a IPAddress
-
getEndIp
IPAddress getEndIp()Information provided by the PKI file:
\brief Returns the end IP address of this pool. \return ip, the end IP address of this pool.- Returns:
- IPAddress Returns a IPAddress
-
setDnsServerIp
Information provided by the PKI file:
\brief Sets the DNS server IP address. \param ipAddress, the DNS server IP address.- Parameters:
ipAddress- Takes in a parameter of ipAddress
-
getDnsServerIp
IPAddress getDnsServerIp()Information provided by the PKI file:
\brief Returns the DNS server IP address. \return ip, the DNS server IP address.- Returns:
- IPAddress Returns a IPAddress
-
getDomainName
String getDomainName()Information provided by the PKI file:
\brief Returns the domain name. \return string, the domain name.- Returns:
- String Returns a String
-
getMaxUsers
int getMaxUsers()Information provided by the PKI file:
\brief Returns the maximum number of users. \return int, the maximum number of users.- Returns:
- int Returns a int
-
setMaxUsers
void setMaxUsers(int max) Information provided by the PKI file:
\brief Set max users \param max, the maximum number of users.- Parameters:
max- Takes in a parameter of max
-
getTftpAddress
IPAddress getTftpAddress()Information provided by the PKI file:
\brief Returns the IP address of the TFTP server. \return ip, the IP address of the TFTP server.- Returns:
- IPAddress Returns a IPAddress
-
getWlcAddress
IPAddress getWlcAddress()- Returns:
- IPAddress Returns a IPAddress
-